public abstract class BaseTraceWriter extends java.lang.Object implements TraceWriter
TraceWriter
to a
TraceWriterManager
This class must be extended to provide the functionality to trace
to different streams. The doPrintln () method must be
implemented by the extending class.
Modifier | Constructor and Description |
---|---|
protected |
BaseTraceWriter(int[] traceLevels,
java.lang.String name,
java.lang.String description)
BaseTraceWriter with trace levels as passed in traceLevels in the array falling outside the
range Trace.LOWEST_LEVEL and Trace.HIGHEST_LEVEl are ignored
|
protected |
BaseTraceWriter(int maxTraceLevel,
java.lang.String name,
java.lang.String description)
BaseTraceWriter that traces all levels upto the maxTraceLevel The trace level is maintained
in the range [Trace.HIGHEST_LEVEL, Trace.LOWEST_LEVEL ]
|
protected |
BaseTraceWriter(java.lang.String name,
java.lang.String description)
BaseTraceWriter which only traces the lowest level ie severity level, Trace.LOWEST_LEVEL
messages
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Releases any resources associated by this
TraceWriter . |
protected void |
doClose() |
protected void |
doFlush() |
protected abstract void |
doPrintln(java.lang.String message,
int messageNumber)
Must be implemented by the various TraceWriters extending BaseTraceWriter to provide the
specific tracing functionality
|
void |
flush()
Forces output of any messages that have been printed using the
println method |
java.lang.String |
getDescription() |
boolean |
getEnabled()
Returns whether the println method will print anything or not.
|
java.lang.String |
getName() |
int[] |
getTraceLevels() |
void |
println(java.lang.String message,
int severity)
Prints the specified string followed by a carriage return The concrete TraceWriter class will
use the severity to block out messages from a particular stream.
|
void |
setTraceLevels(int[] levels)
set the trace levels that will be traced by this TraceWriter
|
java.lang.String |
toString() |
protected BaseTraceWriter(java.lang.String name, java.lang.String description)
name
- description
- Trace
protected BaseTraceWriter(int maxTraceLevel, java.lang.String name, java.lang.String description)
maxTraceLevel
- name
- description
- Trace
protected BaseTraceWriter(int[] traceLevels, java.lang.String name, java.lang.String description)
traceLevels
- array of trace levelsname
- description
- Trace
public final void println(java.lang.String message, int severity)
TraceWriter
println
in interface TraceWriter
message
- The string to printseverity
- The severity of the trace.Trace
protected abstract void doPrintln(java.lang.String message, int messageNumber)
public final void close()
TraceWriter
TraceWriter
.close
in interface TraceWriter
protected void doClose()
public final void flush()
TraceWriter
println
methodflush
in interface TraceWriter
protected void doFlush()
public boolean getEnabled()
TraceWriter
TraceWriter
will always return false
from this method.getEnabled
in interface TraceWriter
public final java.lang.String getName()
getName
in interface TraceWriter
public final java.lang.String getDescription()
getDescription
in interface TraceWriter
public final java.lang.String toString()
toString
in class java.lang.Object
public final void setTraceLevels(int[] levels)
TraceWriter
setTraceLevels
in interface TraceWriter
levels
- Array of trace levelsTrace
public final int[] getTraceLevels()
getTraceLevels
in interface TraceWriter